home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / dnssd / publicservice.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-10-10  |  4.6 KB  |  150 lines
  1. /* This file is part of the KDE project
  2.  *
  3.  * Copyright (C) 2004, 2005 Jakub Stachowski <qbast@go2.pl>
  4.  *
  5.  * This library is free software; you can redistribute it and/or
  6.  * modify it under the terms of the GNU Library General Public
  7.  * License as published by the Free Software Foundation; either
  8.  * version 2 of the License, or (at your option) any later version.
  9.  *
  10.  * This library is distributed in the hope that it will be useful,
  11.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13.  * Library General Public License for more details.
  14.  *
  15.  * You should have received a copy of the GNU Library General Public License
  16.  * along with this library; see the file COPYING.LIB.  If not, write to
  17.  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18.  * Boston, MA 02110-1301, USA.
  19.  */
  20.  
  21. #ifndef DNSSDPUBLICSERVICE_H
  22. #define DNSSDPUBLICSERVICE_H
  23.  
  24. #include <qobject.h>
  25. #include <dnssd/servicebase.h>
  26.  
  27. class KURL;
  28. namespace DNSSD
  29. {
  30. class PublicServicePrivate;
  31.  
  32. /**
  33. This class is most important for application that wants to announce its service on network. 
  34. Suppose that you want to make your web server public - this is simplest way:
  35.  
  36. \code
  37. DNSSD::PublicService *service = new DNSSD::PublicService("My files","_http._tcp",80);
  38. bool isOK = service->publish();
  39. \endcode
  40.  
  41. In this example publish() is synchronous - it will not return until publishing is complete.
  42. This is usually not too long but it can freeze application's GUI for a moment.
  43. Asynchronous publishing is better for responsiveness. Example:
  44.  
  45. \code
  46. DNSSD::PublicService *service = new DNSSD::PublicService("My files","_http._tcp",80);
  47. connect(service,SIGNAL(published(bool)),this,SLOT(wasPublished(bool)));
  48. service->publishAsync();
  49. \endcode
  50.  
  51.  
  52. @short This class represents local service being published
  53. @author Jakub Stachowski
  54.  */
  55.  
  56. class KDNSSD_EXPORT PublicService : public QObject, public ServiceBase
  57. {
  58.     Q_OBJECT
  59. public:
  60.     /**
  61.     @param name Service name. If set to QString::null, computer name will be used and will be
  62.     available via serviceName() after successful registration
  63.     @param type Service type. Has to be in form _sometype._udp or _sometype._tcp
  64.     @param port Port number. Set to 0 to "reserve" service name. 
  65.     @param domain Domain name. If left as QString:null, user configuration will be used. "local."
  66.         means local LAN
  67.      */
  68.     PublicService(const QString& name=QString::null,const QString& type=QString::null,
  69.               unsigned int port=0,const QString& domain=QString::null);
  70.  
  71.     ~PublicService();
  72.     
  73.     /**
  74.     Stops publishing or abort incomplete publish request. Useful when you want to disable service 
  75.     for some time.
  76.      */
  77.     void stop();
  78.     
  79.     /**
  80.     Synchrounous publish. Application will be freezed until publishing is complete.
  81.     @return true if successfull.
  82.      */
  83.     bool publish();
  84.     
  85.     /**
  86.     Returns true is currently published
  87.      */
  88.     bool isPublished() const;
  89.     
  90.     /**
  91.     Asynchronous version of publish(). It return immediately and emits signal published(bool)
  92.     when completed. Note that in case of early detected error (like bad service type) signal may be 
  93.     emitted before return of this function.
  94.      */
  95.     void publishAsync();
  96.  
  97.     /**
  98.     Sets new text properties. If services is already published, it will be re-announced with new data.
  99.     */
  100.     void setTextData(const QMap<QString,QString>& textData);
  101.     
  102.     /**
  103.     Sets name of the service.  If service is currently published, it will be re-announced with new data.
  104.      */
  105.     void setServiceName(const QString& serviceName);
  106.     
  107.     /**
  108.     Sets type of service. It has to in form of _type._udp or _type._tcp.  If service is 
  109.     currently published, it will be re-announced with new data.
  110.      */
  111.     void setType(const QString& type);
  112.  
  113.     /** 
  114.     Sets port. If service is currently published, it will be re-announced with new data.
  115.      */
  116.     void setPort(unsigned short port); 
  117.     
  118.     /**
  119.     Sets domain where service is published. "local." means local LAN. If service is currently 
  120.     published, it will be re-announced with new data.
  121.      */
  122.     void setDomain(const QString& domain);
  123.     
  124.     /**
  125.     Translates service into URL that can be sent to another user. 
  126.     @param host Use specified hostname. If left empty, public IP address (the one used for 
  127.     default route) will be used.
  128.     @since 3.5
  129.      */
  130.     const KURL toInvitation(const QString& host=QString::null);
  131.  
  132. signals:
  133.     /**
  134.     Emitted when publishing is complete - parameter is set to true if it was successfull. It will also
  135.     emitted when name, port or type of already published service is changed.
  136.     */
  137.     void published(bool);
  138. private:
  139.     PublicServicePrivate *d;
  140.  
  141. protected:
  142.     virtual void customEvent(QCustomEvent* event);
  143.     virtual void virtual_hook(int, void*);
  144. };
  145.  
  146.  
  147. }
  148.  
  149. #endif
  150.